home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / u_man / cat1 / rtmon-client.z / rtmon-client
Encoding:
Text File  |  2002-10-03  |  9.6 KB  |  199 lines

  1.  
  2.  
  3.  
  4. RRRRTTTTMMMMOOOONNNN----CCCCLLLLIIIIEEEENNNNTTTT((((1111))))                                                RRRRTTTTMMMMOOOONNNN----CCCCLLLLIIIIEEEENNNNTTTT((((1111))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      rtmon-client  - client for collecting real-time event data from rtmond
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      rrrrttttmmmmoooonnnn----cccclllliiiieeeennnntttt [ ----dddd ] [ ----ffff _f_i_l_e_n_a_m_e ] [ ----hhhh _h_o_s_t_n_a_m_e ] [ ----pppp _c_p_u-_l_i_s_t ] [ ----mmmm
  13.      _e_v_e_n_t-_m_a_s_k ] [ ----nnnn ] [ ----OOOO ] [ ----tttt _t_i_m_e_o_u_t ] [ ----vvvv ]
  14.  
  15. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  16.      rrrrttttmmmmoooonnnn----cccclllliiiieeeennnntttt connects to the rrrrttttmmmmoooonnnndddd daemon running on the machine
  17.      _h_o_s_t_n_a_m_e and collects event data for one or more CPUs.  This event data
  18.      can be displayed by programs such as ppppaaaarrrr(1), rrrrttttmmmmoooonnnn----dddduuuummmmpppp(1), and the
  19.      optional IIIIRRRRIIIIXXXXvvvviiiieeeewwww(1) product.
  20.  
  21.      If event collection is done for an unspecified period of time (see the ----tttt
  22.      option below) then rrrrttttmmmmoooonnnn----cccclllliiiieeeennnntttt will collect event data until it is
  23.      interrupted.
  24.  
  25. OOOOPPPPTTTTIIIIOOOONNNNSSSS
  26.      ----dddd   Enable debugging.  Debugging enables additional error messages and
  27.           the creation of a debugging file that contains a human readable list
  28.           of the events that were collected (see the ----ffff option below).
  29.  
  30.      ----ffff _f_i_l_e_n_a_m_e
  31.           Write event data to one or more files with names derived from
  32.           _f_i_l_e_n_a_m_e.  In normal operation rrrrttttmmmmoooonnnn----cccclllliiiieeeennnntttt will write all event
  33.           data to a single file named _f_i_l_e_n_a_m_e.  If the ----OOOO option is specified
  34.           then event data is written to multiple files, one for each CPU where
  35.           data is collected, and these files are named _f_i_l_e_n_a_m_e.wwwwvvvvrrrr._c_p_u, where
  36.           _c_p_u is the number of the CPU on which data was collected.  In
  37.           addition, if debugging is enabled with the ----dddd option, per-CPU
  38.           debugging information is written to files named _f_i_l_e_n_a_m_e.ddddbbbbgggg._c_p_u.
  39.           By default rrrrttttmmmmoooonnnn----cccclllliiiieeeennnntttt uses the string ddddeeeeffffaaaauuuulllltttt in constructing file
  40.           names.
  41.  
  42.      ----hhhh  hhhhoooossssttttnnnnaaaammmmeeee
  43.           Connect to the server on the specified host.  rrrrttttmmmmoooonnnn----cccclllliiiieeeennnntttt first
  44.           tries to use _h_o_s_t_n_a_m_e as the pathname of a UNIX domain socket on the
  45.           local host; that failing it tries it as a host name or Internet
  46.           address (specified using the usual ``dot notation'').  If _h_o_s_t_n_a_m_e
  47.           is an empty string then rrrrttttmmmmoooonnnn----cccclllliiiieeeennnntttt uses the default scheme for
  48.           connecting to a server: first try to reach a server through the
  49.           default UNIX domain socket, if that fails contact a server through
  50.           the loopback interface.
  51.  
  52.      ----pppp _c_p_u-_l_i_s_t
  53.           Collect data on the set of CPUs specified by _c_p_u-_l_i_s_t.  CPUs are
  54.           specified as a comma-separated list of CPU numbers or range of CPU
  55.           numbers.  CPUs are numbered starting at zero.  For example, ----pppp _1,_4-
  56.           _7,_1_1 means processors 1, 4, 5, 6, 7, and 11.  An open-ended range is
  57.           interpreted as all CPUs to the maximum CPU number; e.g.  _2- on an
  58.           8-processor system is the same as _2-_7.  The CPU list must be one
  59.           string with no white space.  By default, rrrrttttmmmmoooonnnn----cccclllliiiieeeennnntttt collects data
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. RRRRTTTTMMMMOOOONNNN----CCCCLLLLIIIIEEEENNNNTTTT((((1111))))                                                RRRRTTTTMMMMOOOONNNN----CCCCLLLLIIIIEEEENNNNTTTT((((1111))))
  71.  
  72.  
  73.  
  74.           for all CPUs.
  75.  
  76.      ----mmmm _e_v_e_n_t-_m_a_s_k
  77.           Collect only events specified by _e_v_e_n_t-_m_a_s_k.  An _e_v_e_n_t _m_a_s_k
  78.           specifies a set of events; it is a set of _e_v_e_n_t _c_l_a_s_s_e_s with each
  79.           class specified symbolically as one of the following:
  80.  
  81.           NNNNaaaammmmeeee        DDDDeeeessssccccrrrriiiippppttttiiiioooonnnn
  82.           all         All events (default)
  83.           alloc       Memory allocation
  84.           disk        Disk i/o work
  85.           intr        Hardware interrupts
  86.           io          I/O-related events (disk+intr)
  87.           netflow     Network I/O flow
  88.           netsched    Network I/O scheduling
  89.           network     Network-related events (netflow+netsched)
  90.           profile     Kernel profiling
  91.           scheduler   Process and thread scheduler
  92.           signal      Signal delivery and reception
  93.           syscall     System calls and their arguments
  94.           task        Process and thread scheduling
  95.           taskproc    Process scheduling (system threads are not included)
  96.           vm          Virtual memory operation
  97.  
  98.           Event class names are case insensitive; i.e. ``SIGNAL'' is
  99.           interpreted the same as ``signal''.  Multiple event classes may be
  100.           included by using a ``+'', ``|'', or ``,'' symbol to separate the
  101.           names.  Event classes may be excluded by using a ``-'' to separate
  102.           the name.  For example, ``network+io-disk'' indicates all network
  103.           and i/o events should be included except for disk-related events.
  104.           In addition to the above names, a number may be used to specify a
  105.           value, where the various events are selected by bits in the value,
  106.           as defined in ``<sys/rtmon.h>''.
  107.  
  108.           Note that under some circumstances events not in the specified
  109.           classes may also be collected.  This can happen when ``unclassified
  110.           events'', such as those generated by user applications, are
  111.           collected.
  112.  
  113.      ----nnnn   Do not merge the per-CPU event data streams.  This can be useful if
  114.           merging slows down rrrrttttmmmmoooonnnn----cccclllliiiieeeennnntttt so much that it causes data to
  115.           dropped by the server.
  116.  
  117.      ----tttt _t_i_m_e_o_u_t
  118.           Collect data for _t_i_m_e_o_u_t seconds.
  119.  
  120.      ----vvvv   When rrrrttttmmmmoooonnnn----cccclllliiiieeeennnntttt is used to collect data from a remote system (via
  121.           the ----hhhh option) it is not normally possible to collect system call
  122.           event data for processes unless the remote processes are specially
  123.           marked to allow the data to be collected.  This marking must be
  124.           performed on the remote system via rrrrttttmmmmoooonnnn----rrrruuuunnnn(1).  Permissions to
  125.           perform this marking are handled via standard process permissions on
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. RRRRTTTTMMMMOOOONNNN----CCCCLLLLIIIIEEEENNNNTTTT((((1111))))                                                RRRRTTTTMMMMOOOONNNN----CCCCLLLLIIIIEEEENNNNTTTT((((1111))))
  137.  
  138.  
  139.  
  140.           the remote system.  Access to the system call data is controlled via
  141.           a security cookie that is granted by the remote rrrrttttmmmmoooonnnndddd.  When the ----vvvv
  142.           option is provided to rrrrttttmmmmoooonnnn----cccclllliiiieeeennnntttt this security cookie is printed.
  143.           The security cookie must then be used in the rrrrttttmmmmoooonnnn----rrrruuuunnnn command on
  144.           the remote system in order to properly tag the collected system call
  145.           data.
  146.  
  147. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  148.      _U_n_a_b_l_e _t_o _c_o_n_t_a_c_t _r_t_m_o_n _s_e_r_v_i_c_e _o_n _h_o_s_t <_h_o_s_t_n_a_m_e>.  There is no rrrrttttmmmmoooonnnndddd
  149.      server process running on the target system.
  150.  
  151. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  152.      ppppaaaarrrr(1), rrrrttttmmmmoooonnnn----rrrruuuunnnn(1), rrrrttttmmmmoooonnnndddd(1), IIIIRRRRIIIIXXXXvvvviiiieeeewwww(1), rrrrttttmmmmoooonnnn____lllloooogggg____uuuusssseeeerrrr____ttttssssttttaaaammmmpppp(3)
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.